Explaining comments

코드를 읽다가 어렵게 이해를 했다면 코멘트로 남기기. 타이딩 중 하나.

You know that moment when you’re reading some code and you say, “Oh, so that’s what’s going on!” That’s a valuable moment. Record it. …

Write to someone specific, even if they aren’t much like you. Are you the only biologist on your team of computer scientists? Then you’d better explain any biology context in the code, even if it seems obvious to you. The point is to think from the perspective of someone else, and try to preemptively address likely questions.

—Tidy first? A personal exercise in empirical software design